Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SPARK-49494][DOCS] Use spark logos from spark-website in docs #47966

Closed
wants to merge 3 commits into from

Conversation

yaooqinn
Copy link
Member

@yaooqinn yaooqinn commented Sep 3, 2024

What changes were proposed in this pull request?

Use spark logos from spark-website in docs and remove them from spark main repo

Why are the changes needed?

  • reduce spark-website incremental size
  • fix some cases when /img/spark-logo-rev.svg is invalid

Does this PR introduce any user-facing change?

no

How was this patch tested?

doc build, https://github.com/yaooqinn/spark/actions/runs/10676269598/artifacts/1884295142

Was this patch authored or co-authored using generative AI tooling?

no

@yaooqinn
Copy link
Member Author

yaooqinn commented Sep 3, 2024

cc @dongjoon-hyun @cloud-fan @HyukjinKwon, thank you

Copy link
Member

@dongjoon-hyun dongjoon-hyun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering this is a safe way which is able to provide a recovery from the disaster, @yaooqinn .

For example, how can we recover our website when ASF Infra team lost the files at https://spark.apache.org/images/spark-logo-rev.svg ?

@yaooqinn
Copy link
Member Author

yaooqinn commented Sep 3, 2024

Thank you @dongjoon-hyun. I'm not using official logos in the infrastructure service of https://apache.org/logos since we have not fully uploaded all our logo variants to it.

The https://spark.apache.org/images/spark-logo-rev.svg points to https://github.com/apache/spark-website/blob/asf-site/site/images/spark-logo-rev.svg which is a copy from https://github.com/apache/spark-website/blob/asf-site/images/spark-logo-rev.svg by jekyll build. I guess we handle these files ourselves.

In this case, if the spark-logo-rev.svg is 'lost', which probably means that the entire Apache Web Service is in downtime, and https://spark.apache.org is also unreachable.

@dongjoon-hyun
Copy link
Member

dongjoon-hyun commented Sep 3, 2024

Maybe, I wasn't clear enough. What I meant was the case ASF website lost the disk and we need to republish our website cleanly. Let me rephrase my question more specifically. So, all deleted files of this PR are redundant ones because our spark-website.git already has them? If then, sounds good to me.

In this case, if the spark-logo-rev.svg is 'lost', which probably means that the entire Apache Web Service is in downtime, and https://spark.apache.org/ is also unreachable.

@yaooqinn
Copy link
Member Author

yaooqinn commented Sep 3, 2024

Yes, @dongjoon-hyun. The 'spark-website.git' has them

Copy link
Member

@dongjoon-hyun dongjoon-hyun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1, LGTM.

@dongjoon-hyun
Copy link
Member

Merged to master! Thank you.

yaooqinn added a commit that referenced this pull request Sep 18, 2024
… via Live GitHub Pages Updates

### What changes were proposed in this pull request?

This pull request introduces functionalities that enable 'Document and Feature Preview on the master branch via Live GitHub Pages Updates'.

### Why are the changes needed?

- Instead of limited 72-hour voting phases, it provides the developer community with more opportunities to preview and verify the documentation contents.
- Instead of waiting for the final announcement of an official spark feature release, users can now preview some of the ongoing documented features, increasing the willingness to upgrade, sensing breaking changes in advance, and reducing the burden during the final upgrades.

### Does this PR introduce _any_ user-facing change?

No

### How was this patch tested?

An [example](https://yaooqinn.github.io/spark-gh-pages/) has been established by this repo - https://github.com/yaooqinn/spark-gh-pages

- Broken logo links are fixed at #47966

### Was this patch authored or co-authored using generative AI tooling?
no

Closes #47968 from yaooqinn/SPARK-49495.

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Kent Yao <yao@apache.org>
yaooqinn added a commit to yaooqinn/spark that referenced this pull request Sep 20, 2024
…h via Live GitHub Pages Updates

    ### What changes were proposed in this pull request?

    This pull request introduces functionalities that enable 'Document and Feature Preview on the master branch via Live GitHub Pa
ges Updates'.

    ### Why are the changes needed?

    - Instead of limited 72-hour voting phases, it provides the developer community with more opportunities to preview and verify
the documentation contents.
    - Instead of waiting for the final announcement of an official spark feature release, users can now preview some of the ongoin
g documented features, increasing the willingness to upgrade, sensing breaking changes in advance, and reducing the burden during
the final upgrades.

    ### Does this PR introduce _any_ user-facing change?

    No

    ### How was this patch tested?

    An [example](https://yaooqinn.github.io/spark-gh-pages/) has been established by this repo - https://github.com/yaooqinn/spark
-gh-pages

    - Broken logo links are fixed at apache#47966

    ### Was this patch authored or co-authored using generative AI tooling?
    no
IvanK-db pushed a commit to IvanK-db/spark that referenced this pull request Sep 20, 2024
### What changes were proposed in this pull request?

Use spark logos from spark-website in docs and remove them from spark main repo

### Why are the changes needed?

- reduce spark-website incremental size
- fix some cases when `/img/spark-logo-rev.svg` is invalid

### Does this PR introduce _any_ user-facing change?
no

### How was this patch tested?
doc build, https://github.com/yaooqinn/spark/actions/runs/10676269598/artifacts/1884295142

### Was this patch authored or co-authored using generative AI tooling?
no

Closes apache#47966 from yaooqinn/SPARK-49494.

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
attilapiros pushed a commit to attilapiros/spark that referenced this pull request Oct 4, 2024
### What changes were proposed in this pull request?

Use spark logos from spark-website in docs and remove them from spark main repo

### Why are the changes needed?

- reduce spark-website incremental size
- fix some cases when `/img/spark-logo-rev.svg` is invalid

### Does this PR introduce _any_ user-facing change?
no

### How was this patch tested?
doc build, https://github.com/yaooqinn/spark/actions/runs/10676269598/artifacts/1884295142

### Was this patch authored or co-authored using generative AI tooling?
no

Closes apache#47966 from yaooqinn/SPARK-49494.

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
attilapiros pushed a commit to attilapiros/spark that referenced this pull request Oct 4, 2024
… via Live GitHub Pages Updates

### What changes were proposed in this pull request?

This pull request introduces functionalities that enable 'Document and Feature Preview on the master branch via Live GitHub Pages Updates'.

### Why are the changes needed?

- Instead of limited 72-hour voting phases, it provides the developer community with more opportunities to preview and verify the documentation contents.
- Instead of waiting for the final announcement of an official spark feature release, users can now preview some of the ongoing documented features, increasing the willingness to upgrade, sensing breaking changes in advance, and reducing the burden during the final upgrades.

### Does this PR introduce _any_ user-facing change?

No

### How was this patch tested?

An [example](https://yaooqinn.github.io/spark-gh-pages/) has been established by this repo - https://github.com/yaooqinn/spark-gh-pages

- Broken logo links are fixed at apache#47966

### Was this patch authored or co-authored using generative AI tooling?
no

Closes apache#47968 from yaooqinn/SPARK-49495.

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Kent Yao <yao@apache.org>
himadripal pushed a commit to himadripal/spark that referenced this pull request Oct 19, 2024
### What changes were proposed in this pull request?

Use spark logos from spark-website in docs and remove them from spark main repo

### Why are the changes needed?

- reduce spark-website incremental size
- fix some cases when `/img/spark-logo-rev.svg` is invalid

### Does this PR introduce _any_ user-facing change?
no

### How was this patch tested?
doc build, https://github.com/yaooqinn/spark/actions/runs/10676269598/artifacts/1884295142

### Was this patch authored or co-authored using generative AI tooling?
no

Closes apache#47966 from yaooqinn/SPARK-49494.

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
himadripal pushed a commit to himadripal/spark that referenced this pull request Oct 19, 2024
… via Live GitHub Pages Updates

### What changes were proposed in this pull request?

This pull request introduces functionalities that enable 'Document and Feature Preview on the master branch via Live GitHub Pages Updates'.

### Why are the changes needed?

- Instead of limited 72-hour voting phases, it provides the developer community with more opportunities to preview and verify the documentation contents.
- Instead of waiting for the final announcement of an official spark feature release, users can now preview some of the ongoing documented features, increasing the willingness to upgrade, sensing breaking changes in advance, and reducing the burden during the final upgrades.

### Does this PR introduce _any_ user-facing change?

No

### How was this patch tested?

An [example](https://yaooqinn.github.io/spark-gh-pages/) has been established by this repo - https://github.com/yaooqinn/spark-gh-pages

- Broken logo links are fixed at apache#47966

### Was this patch authored or co-authored using generative AI tooling?
no

Closes apache#47968 from yaooqinn/SPARK-49495.

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Kent Yao <yao@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants